home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #1 / Amiga Plus CD - 2000 - No. 1.iso / Tools / Text / Edit / GoldED-Demo / installdata / golded / developer / api / examples / readme
Encoding:
Text File  |  1999-12-03  |  3.6 KB  |  90 lines
  1. CONTENTS
  2.  
  3.   API examples (compiled binaries can be found in the "bin/" drawer)
  4.  
  5. COPYIGHT
  6.  
  7.   ©1999 Dietmar Eilert. All Rights Reserved.
  8.  
  9.   Dietmar Eilert
  10.   Mies-v-d-Rohe-Str.31, 52074 Aachen, Germany
  11.   Phone: +49-(0)179-5987061 German/English
  12.   E-Mail: Dietmar.Eilert@post.rwth-aachen.de
  13.   E-Mail: dietmar_eilert@yahoo.de (alternative address)
  14.   WWW:    http://members.tripod.com/golded
  15.   Mirror: http://members.xoom.com/golded
  16.  
  17. INTRODUCTION
  18.  
  19.   The interesting stuff can always be found in the "funcs.c" file of each  of
  20.   the  projects  listed  below. The other files contain glue code required to
  21.   compile "funcs.c" into a valid  shared  libary  and  should  be  of  little
  22.   interest  to  you  (except  that tag.a and the makefile contain the plug-in
  23.   name). I'd recommend to use DICE for compiling these projects (which  is  a
  24.   freeware  compiler)  even  if  you  are normally using a different compiler
  25.   especially if you are not familiar with developing libaries.
  26.  
  27. MIRROR
  28.  
  29.   This plug-in highlights the matching bracket if the cursor is placed over a
  30.   bracket.  The  source  code  demonstrates  how plug-ins can detect keyboard
  31.   events, read text in editor windows and set block markers.
  32.  
  33. STARTUP
  34.  
  35.   This plug-in starts a Rexx macro when the plug-in starts. The macro name is
  36.   to  be  provided  by  the  user  as  startup  argument  for this API client
  37.   (arguments for plug-ins can be set with a doubleclick on the  plug-in  name
  38.   in  GoldED's  API  configuration  dialog). The source code demonstrates how
  39.   startup arguments can be used by API clients and how  to  send  synchronous
  40.   Rexx  commands (see REGISTER example for sending asynchronous Rexx commands
  41.   to GoldED).
  42.  
  43. REXX
  44.  
  45.   This plug-in adds a few new commands to the  command  set  of  GoldED.  For
  46.   example,  DISPLAYBEEP  will flash the display. The source code demonstrates
  47.   how plug-ins can extend the command set of GoldED.
  48.  
  49. X
  50.  
  51.   This plug-in opens a container and renders  a  big  "X".  The  source  code
  52.   demonstrates how to open a container and how to use clipping when rendering
  53.   to it.
  54.  
  55. INFO
  56.  
  57.   This plug-in shows help texts related to the word under  the  cursor  in  a
  58.   container. The help texts are read from a configurable dictionary file. The
  59.   source code again demonstrates rendering in containers. The dictionary file
  60.   to  be  used  by  the  plug-in  must  be  configured as startup option (see
  61.   description of STARTUP project). You can use the file of the sas-c  add-on,
  62.   "golded:add-ons/sas-c/quickinfo/os3.words".
  63.  
  64. TIMER (FOR ADVANCED PROGRAMMERS ONLY !)
  65.  
  66.   This plug-in shows text lines from  a  song  in  GoldED's  status  bar  and
  67.   updates  the  display  every  second.  The  source code demonstrates how to
  68.   display text in the status bar and how to handle message ports  in  clients
  69.   (for example the message port of a timer device).
  70.  
  71. BUTTON
  72.  
  73.   This plug-in opens a container and displays a  single  button.  The  source
  74.   code demonstrates how to use gadgets in plug-ins.
  75.  
  76. DATATYPE (BETA VERSION, SEE SOURCE CODE FOR KNOWN BUGS)
  77.  
  78.   This plug-in shows a file (text file, image, guide  file)  in  a  container
  79.   using  the  datatypes  library.  The  name of the file must be specified as
  80.   startup-option. The source code demonstrates how the datatypes library  can
  81.   be used to embed complex objects into editor windows.
  82.  
  83. REGISTER
  84.  
  85.   This plug-in adds register buttons to editor windows, one  for  each  text.
  86.   These  buttons  can  be  used to switch quickly between windows. The source
  87.   code demonstrates how container plug-ins can respond to  mouse  clicks  and
  88.   how  to send asynchronous Rexx messages to the editor. It also demonstrates
  89.   the effect of container styles (this example uses a borderless container).
  90.